Skip to content

Fix spell check failures and typos #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Sep 9, 2022
Merged

Fix spell check failures and typos #332

merged 3 commits into from
Sep 9, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 8, 2022

In the latest release of the codespell tool used for automated spell checking of the files of this project, the misspelled words dictionary was expanded. This resulted in several detections, both false positives and true positives.

The failing check is fixed here by configuring the tool to prevent the false positives and by fixing the misspelled words that produced the actionable true positives.

While I was at it, I performed a comprehensive review of all documentation content in the repository and fixed additional typos identified manually.

@per1234
Exclude BearSSL library files from spell check
90d659c 
The latest release of the codespell tool used for automated spell checking of the files of this project included an
expansion of the misspelled words dictionary.

This caused the spell checker to trigger on some content in the BearSSL library vendored in this project. These included
both false and true positives. Although the former can be fixed by ignoring the specific word and the latter by fixing
the typo, it doesn't really make sense to be checking these files which appear to be mostly copies of content maintained
externally.

For this reason, the best approach will be to exclude the files from the check entirely.
@per1234
Fix spell check false positive by ignoring word
80d22e9 
In the latest release of the codespell tool used for automated spell checking of the files of this project, the word
"bu" was added to the codespell misspelled words dictionary as a misspelling of "by".

This caused a false detection of a CBOR map label `bu` as a misspelling, resulting in a failing spell check result.

Since the occurrence of this word is correct and intended in this project, the false positive is resolved by configuring
codespell to ignore the problematic word.
@per1234
Fix typos in documentation
292e1b1
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project topic: infrastructure Related to project infrastructure labels Sep 8, 2022
@per1234 per1234 requested review from aentinger and pennam September 8, 2022 12:22
@per1234 per1234 self-assigned this Sep 8, 2022
@pennam
Copy link
Collaborator

pennam commented Sep 8, 2022

Thanks @per1234

@github-actions
Copy link

github-actions bot commented Sep 8, 2022

Memory usage change @ 292e1b1

Board flash % RAM for global variables %
arduino:mbed_nano:nanorp2040connect 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:mbed_nicla:nicla_vision 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkr1000 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrgsm1400 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrnb1500 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrwan1300 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:mkrwifi1010 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
arduino:samd:nano_33_iot 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
esp32:esp32:esp32 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
esp8266:esp8266:huzzah 0 - 0 0.0 - 0.0 0 - 0 0.0 - 0.0
Click for full report table
Board examples/ArduinoIoTCloud-Advanced
flash		 % examples/ArduinoIoTCloud-Advanced
RAM for global variables		 % examples/ArduinoIoTCloud-Basic
flash		 % examples/ArduinoIoTCloud-Basic
RAM for global variables		 % examples/utility/ArduinoIoTCloud_Travis_CI
flash		 % examples/utility/ArduinoIoTCloud_Travis_CI
RAM for global variables		 % examples/utility/Provisioning
flash		 % examples/utility/Provisioning
RAM for global variables		 % examples/utility/SelfProvisioning
flash		 % examples/utility/SelfProvisioning
RAM for global variables		 %
arduino:mbed_nano:nanorp2040connect 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:mbed_nicla:nicla_vision 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkr1000 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkrgsm1400 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkrnb1500 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkrwan1300 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:mkrwifi1010 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
arduino:samd:nano_33_iot 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
esp32:esp32:esp32 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
esp8266:esp8266:huzzah 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0 0 0.0
Click for full report CSV 
Board,examples/ArduinoIoTCloud-Advanced<br>flash,%,examples/ArduinoIoTCloud-Advanced<br>RAM for global variables,%,examples/ArduinoIoTCloud-Basic<br>flash,%,examples/ArduinoIoTCloud-Basic<br>RAM for global variables,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>flash,%,examples/utility/ArduinoIoTCloud_Travis_CI<br>RAM for global variables,%,examples/utility/Provisioning<br>flash,%,examples/utility/Provisioning<br>RAM for global variables,%,examples/utility/SelfProvisioning<br>flash,%,examples/utility/SelfProvisioning<br>RAM for global variables,%
arduino:mbed_nano:nanorp2040connect,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:mbed_nicla:nicla_vision,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,
arduino:samd:mkr1000,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,
arduino:samd:mkrgsm1400,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,
arduino:samd:mkrnb1500,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,
arduino:samd:mkrwan1300,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,,
arduino:samd:mkrwifi1010,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
arduino:samd:nano_33_iot,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0
esp32:esp32:esp32,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,,
esp8266:esp8266:huzzah,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,0,0.0,,,,,,,,

aentinger
aentinger approved these changes Sep 8, 2022
View reviewed changes
Copy link
Contributor

@aentinger aentinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 Thank you for the effort @per1234 🚀

I won't merge as I don't want to mess with open PRs under work by @pennam - @pennam please merge this once it fits best for you 🙇 .

@pennam pennam merged commit 783ddf4 into arduino-libraries:master Sep 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aentinger aentinger aentinger approved these changes

@pennam pennam Awaiting requested review from pennam

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project topic: infrastructure Related to project infrastructure type: imperfection Perceived defect in any part of project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@per1234 @pennam @aentinger